/*
** $Id: lgc.c,v 2.215.1.2 2017/08/31 16:15:27 roberto Exp $
** Garbage Collector
** See Copyright Notice in lua.h
*/

#define lgc_c
#define LUA_CORE

#include "lprefix.h"


#include <string.h>

#include "lua.h"

#include "ldebug.h"
#include "ldo.h"
#include "lfunc.h"
#include "lgc.h"
#include "lmem.h"
#include "lobject.h"
#include "lstate.h"
#include "lstring.h"
#include "ltable.h"
#include "ltm.h"


/*
** internal state for collector while inside the atomic phase. The
** collector should never be in this state while running regular code.
*/
#define GCSinsideatomic    (GCSpause + 1)

/*
** cost of sweeping one element (the size of a small object divided
** by some adjust for the sweep speed)
*/
#define GCSWEEPCOST  ((sizeof(TString) + 4) / 4)

/* maximum number of elements to sweep in each single step */
#define GCSWEEPMAX  (cast_int((GCSTEPSIZE / GCSWEEPCOST) / 4))

/* cost of calling one finalizer */
#define GCFINALIZECOST  GCSWEEPCOST


/*
** macro to adjust 'stepmul': 'stepmul' is actually used like
** 'stepmul / STEPMULADJ' (value chosen by tests)
*/
#define STEPMULADJ    200


/*
** macro to adjust 'pause': 'pause' is actually used like
** 'pause / PAUSEADJ' (value chosen by tests)
*/
#define PAUSEADJ    100

/*
** 'makewhite' erases all color bits then sets only the current white
** bit
*/
#define maskcolors (~(bitmask(BLACKBIT) | WHITEBITS))
/**
 * 将对象标记为白色（未被垃圾回收器标记为活跃状态）。
 *
 * @param g 指向垃圾回收器状态的指针。
 * @param x 需要标记的对象指针。
 * @note 此宏通过修改对象的标记位，将其颜色设置为白色（未被标记）。
 *       白色对象表示在当前垃圾回收周期中未被访问。（这里白色分成了两种，目的是方便快速gc）
 */
#define makewhite(g, x) \
    (x->marked = cast_byte((x->marked & maskcolors) | luaC_white(g)))

/**
 * @brief 将对象的标记位从白色重置为灰色。
 * @param x 指向目标对象的指针，该对象的标记位将被修改。
 * @details 此宏通过清除对象的 WHITEBITS 标记位，将其状态从白色（未处理）转换为灰色（待处理）。
 * 通常用于垃圾回收算法中标记阶段的颜色转换。
 */
#define white2gray(x) resetbits(x->marked, WHITEBITS)
#define black2gray(x) resetbit(x->marked, BLACKBIT)

/**
 * 检查给定的值是否为白色（未被标记为活跃的垃圾回收对象）。
 * @param x 要检查的值。
 * @return 如果值是可回收对象且未被标记为活跃（白色），则返回真；否则返回假。
 */
#define valiswhite(x) (iscollectable(x) && iswhite(gcvalue(x)))

#define checkdeadkey(n) lua_assert(!ttisdeadkey(gkey(n)) || ttisnil(gval(n)))

/**
 * @brief 检查对象的类型一致性。
 *
 * 该宏用于断言对象 `obj` 的类型是否一致。如果 `obj` 是可收集类型（collectable），
 * 则进一步检查其类型标记（tag）是否正确。
 *
 * @param obj 要检查的对象。
 *
 * @note 如果检查失败，会触发断言错误。
 */
#define checkconsistency(obj) \
    lua_longassert(!iscollectable(obj) || righttt(obj))

/**
 * 标记一个 Lua 对象为活跃状态（避免被垃圾回收）。
 * 该宏用于垃圾回收过程中，确保对象不会被错误回收。
 *
 * @param g 全局状态指针，指向 Lua 的全局状态。
 * @param o 需要标记的对象。
 * 如果对象是白色（未被标记），则调用 `reallymarkobject` 将其标记为活跃。
 */
#define markvalue(g, o)                      \
    {                                        \
        checkconsistency(o);                 \
        if (valiswhite(o))                   \
            reallymarkobject(g, gcvalue(o)); \
    }

/**
 * 标记对象为活跃状态（避免被垃圾回收）。
 * 如果对象是白色（未被标记），则调用 `reallymarkobject` 进行标记。
 *
 * @param g 全局状态指针。
 * @param t 需要标记的对象。
 */
#define markobject(g, t)                     \
    {                                        \
        if (iswhite(t))                      \
            reallymarkobject(g, obj2gco(t)); \
    }

/*
** mark an object that can be NULL (either because it is really optional,
** or it was stripped as debug info, or inside an uncompleted structure)
*/
#define markobjectN(g, t)  { if (t) markobject(g,t); }

static void reallymarkobject(global_State *g, GCObject *o);


/*
** {======================================================
** Generic functions
** =======================================================
*/


/*
** one after last element in a hash array
*/
#define gnodelast(h)  gnode(h, cast(size_t, sizenode(h)))

/**
 * 将可回收对象 'o' 链接到由 'p' 指向的链表中。
 * 该宏用于管理垃圾回收机制中的对象链表。
 */
/*
** link collectable object 'o' into list pointed by 'p'
*/
#define linkgclist(o, p)  ((o)->gclist = (p), (p) = obj2gco(o))

/*
** If key is not marked, mark its entry as dead. This allows key to be
** collected, but keeps its entry in the table.  A dead node is needed
** when Lua looks up for a key (it may be part of a chain) and when
** traversing a weak table (key might be removed from the table during
** traversal). Other places never manipulate dead keys, because its
** associated nil value is enough to signal that the entry is logically
** empty.
*/
/**
 * 移除哈希表中的无效条目。
 *
 * @param n 指向待移除条目的节点指针。
 *
 * 函数会检查节点的值是否为 nil，并确保键未被标记为白色（未被使用且未标记）。
 * 如果键是无效的（白色），则将其标记为“dead”以便后续清理。
 */
static void removeentry(Node *n)
{
    lua_assert(ttisnil(gval(n)));
    if (valiswhite(gkey(n)))
        setdeadvalue(wgkey(n));  /* unused and unmarked key; remove it */
}

/*
** tells whether a key or value can be cleared from a weak
** table. Non-collectable objects are never removed from weak
** tables. Strings behave as 'values', so are never removed too. for
** other objects: if really collected, cannot keep them; for objects
** being finalized, keep them in keys, but not in values
*/
/**
 * 检查给定的值是否已被垃圾回收器清除。
 *
 * @param g 全局状态指针。
 * @param o 待检查的值指针。
 * @return 如果值未被清除（或为字符串类型），返回0；否则返回1（表示已被清除）。
 *
 * @note 字符串被视为“值”，因此永远不会被标记为弱引用。
 */
static int iscleared(global_State *g, const TValue *o)
{
    if (!iscollectable(o))
        return 0;
    else if (ttisstring(o))
    {
        markobject(g, tsvalue(o));  /* strings are 'values', so are never weak */
        return 0;
    }
    else
        return iswhite(gcvalue(o));
}

/*
** barrier that moves collector forward, that is, mark the white object
** being pointed by a black object. (If in sweep phase, clear the black
** object to white [sweep it] to avoid other barrier calls for this
** same object.)
*/
/**
 * 执行垃圾回收屏障操作，确保对象引用关系的正确性。
 *
 * @param L Lua状态机指针。
 * @param o 被引用的对象（黑色标记）。
 * @param v 引用的对象（白色标记）。
 *
 * 功能说明：
 * - 在垃圾回收的标记阶段，确保黑色对象（o）引用的白色对象（v）不会被错误回收。
 * - 如果当前处于保持不变量的阶段（keepinvariant），则直接标记白色对象（v）为活跃状态。
 * - 如果处于清扫阶段（sweep phase），则将主对象（o）标记为白色，以避免其他屏障操作。
 *
 * 前置条件：
 * - o必须是黑色标记的对象。
 * - v必须是白色标记的对象。
 * - o和v都必须是活跃对象（未被回收）。
 */
void luaC_barrier_(lua_State *L, GCObject *o, GCObject *v)
{
    global_State *g = G(L);
    lua_assert(isblack(o) && iswhite(v) && !isdead(g, v) && !isdead(g, o));
    // 如果在标记传播阶段，则标记成灰色或黑色，如果在清除阶段， 就直接标记成白色
    if (keepinvariant(g))  /* must keep invariant? 不变的 */
        reallymarkobject(g, v);  /* restore invariant  不变的*/
    else {  /* sweep phase */
        lua_assert(issweepphase(g));
        makewhite(g, o);  /* mark main obj. as white to avoid other barriers */
    }
}

/*
** barrier that moves collector backward, that is, mark the black object
** pointing to a white object as gray again.
*/
/**
 * 将表 `t` 重新标记为灰色，并将其添加到 `grayagain` 列表中。
 * 该函数用于垃圾回收（GC）的后向屏障操作。
 *
 * @param L Lua 状态机指针。
 * @param t 需要处理的表指针。
 * @note 调用此函数前需确保表 `t` 是黑色的且未被标记为死亡状态。
 */
void luaC_barrierback_(lua_State *L, Table *t)
{
    global_State *g = G(L);
    lua_assert(isblack(t) && !isdead(g, t));
    black2gray(t);  /* make table gray (again) */
    // 将t添加到grayagain列表中，等待下次垃圾回收
    linkgclist(t, g->grayagain);
}

/*
** barrier for assignments to closed upvalues. Because upvalues are
** shared among closures, it is impossible to know the color of all
** closures pointing to it. So, we assume that the object being assigned
** must be marked.
*/
/**
 * 对 UpVal 对象执行屏障操作，确保在垃圾回收过程中正确处理其引用的对象。
 *
 * @param L Lua 状态机指针。
 * @param uv 需要处理的 UpVal 对象指针。
 *
 * @note 此函数由宏 `luaC_upvalbarrier` 调用，调用前已确保 `uv` 不是开放的 UpVal。
 * @note 如果全局状态 `g` 处于保持不变量的状态（`keepinvariant(g)` 为真），
 *       则会对 `uv->v` 引用的对象进行标记（`markobject`）。
 */
void luaC_upvalbarrier_(lua_State *L, UpVal *uv)
{
    global_State *g = G(L);
    GCObject *o = gcvalue(uv->v);
    lua_assert(!upisopen(uv));  /* ensured by macro luaC_upvalbarrier */
    if (keepinvariant(g)) markobject(g, o);
}

/**
 * 将垃圾回收对象 `o` 从全局的 `allgc` 列表中移除，并将其固定到 `fixedgc` 列表中。
 * 该函数用于标记对象为“固定”状态，使其不会被垃圾回收器回收。
 *
 * @param L Lua 状态机指针。
 * @param o 需要固定的垃圾回收对象。
 * @note 调用此函数前，对象 `o` 必须是 `allgc` 列表的第一个元素。
 */
void luaC_fix(lua_State *L, GCObject *o)
{
    global_State *g = G(L);
    lua_assert(g->allgc == o); /* object must be 1st in 'allgc' list! */
    white2gray(o);  /* they will be gray forever */
    g->allgc = o->next;  /* remove object from 'allgc' list */
    o->next = g->fixedgc;  /* link it to 'fixedgc' list */
    g->fixedgc = o;
}

/*
** create a new collectable object (with given type and size) and link
** it to 'allgc' list.
*/
/**
 * 创建一个新的垃圾回收对象并将其添加到全局状态的所有GC对象链表中。
 *
 * @param L Lua状态机指针。
 * @param tt 对象的类型标记。
 * @param sz 对象的大小（字节）。
 * @return 返回新创建的垃圾回收对象指针。
 *
 * 该函数会：
 * 1. 分配内存并初始化对象。
 * 2. 设置对象的标记为白色（表示未被标记）。
 * 3. 将对象添加到全局状态的所有GC对象链表的头部。
 */
GCObject *luaC_newobj(lua_State *L, int tt, size_t sz)
{
    global_State *g = G(L);
    GCObject *o = cast(GCObject *, luaM_newobject(L, novariant(tt), sz));
    o->marked = luaC_white(g);
    o->tt = tt;
    o->next = g->allgc;
    g->allgc = o;
    return o;
}

/* }====================================================== */



/*
** {======================================================
** Mark functions
** =======================================================
*/

/*
** mark an object. Userdata, strings, and closed upvalues are visited
** and turned black here. Other objects are marked gray and added
** to appropriate list to be visited (and turned black) later. (Open
** upvalues are already linked in 'headuv' list.)
*/
/**
 * 标记一个对象为灰色或黑色，并根据对象类型更新内存遍历统计。
 *
 * @param g 全局状态指针，用于访问垃圾回收器的状态和内存统计。
 * @param o 需要标记的垃圾回收对象指针。
 *
 * 函数行为：
 * 1. 首先将对象从白色标记为灰色（white2gray）。
 * 2. 根据对象的类型（o->tt）执行不同的处理：
 *    - 短字符串（LUA_TSHRSTR）和长字符串（LUA_TLNGSTR）：标记为黑色，并更新内存统计。
 *    - 用户数据（LUA_TUSERDATA）：标记其元表，标记为黑色，并更新内存统计；如果用户数据的值未被标记，则递归处理。
 *    - 其他类型（如闭包、表、线程等）：将对象链接到灰色列表（g->gray）中。
 * 3. 如果对象类型未知，触发断言（lua_assert）。
 *
 * 注意：
 * - 该函数是垃圾回收器的内部实现细节，通常不直接暴露给外部调用。
 * - 使用 `goto reentry` 实现递归标记，避免栈溢出。
 */
static void reallymarkobject(global_State *g, GCObject *o)
{
reentry:
    white2gray(o);
    switch (o->tt) {
        case LUA_TSHRSTR: {
            gray2black(o);
            g->GCmemtrav += sizelstring(gco2ts(o)->shrlen);
            break;
        }
        case LUA_TLNGSTR: {
            gray2black(o);
            g->GCmemtrav += sizelstring(gco2ts(o)->u.lnglen);
            break;
        }
        case LUA_TUSERDATA: {
            TValue uvalue;
            markobjectN(g, gco2u(o)->metatable);  /* mark its metatable */
            gray2black(o);
            g->GCmemtrav += sizeudata(gco2u(o));
            getuservalue(g->mainthread, gco2u(o), &uvalue);
            if (valiswhite(&uvalue)) {  /* markvalue(g, &uvalue); */
                o = gcvalue(&uvalue);
                goto reentry;
            }
            break;
        }
        case LUA_TLCL: {
            // 将o的gclist指向g->gray，然后将g->gray指向o
            // 这样g->gray就指向了o，原来 g->gray 执行的值被保存在o->gclist中
            // 相当于o位于g->gray的最前面
            linkgclist(gco2lcl(o), g->gray);
            break;
        }
        case LUA_TCCL: {
            linkgclist(gco2ccl(o), g->gray);
            break;
        }
        case LUA_TTABLE: {
            linkgclist(gco2t(o), g->gray);
            break;
        }
        case LUA_TTHREAD: {
            linkgclist(gco2th(o), g->gray);
            break;
        }
        case LUA_TPROTO: {
            linkgclist(gco2p(o), g->gray);
            break;
        }
        default:
            lua_assert(0);
            break;
    }
}

/*
** mark metamethods for basic types
*/
/**
 * 标记全局状态中的元表（metatable）。
 * 遍历所有预定义的元表类型（LUA_NUMTAGS），并对每个元表调用 `markobjectN` 进行标记。
 *
 * @param g 全局状态指针，包含需要标记的元表数组。
 */
static void markmt(global_State *g)
{
    int i;
    for (i = 0; i < LUA_NUMTAGS; i++)
        markobjectN(g, g->mt[i]);
}

/*
** mark all objects in list of being-finalized
*/
/**
 * 标记所有待终结对象（tobefnz链表中的对象）为活跃状态。
 * 该函数用于垃圾回收过程中，确保待终结的对象不会被错误地回收。
 *
 * @param g 全局状态指针，包含垃圾回收相关的上下文信息。
 */
static void markbeingfnz(global_State *g)
{
    GCObject *o;
    for (o = g->tobefnz; o != NULL; o = o->next)
        markobject(g, o);
}

/*
** Mark all values stored in marked open upvalues from non-marked threads.
** (Values from marked threads were already marked when traversing the
** thread.) Remove from the list threads that no longer have upvalues and
** not-marked threads.
*/
/**
 * 遍历全局状态中的线程列表，标记并处理所有打开的 upvalues。
 *
 * 该函数用于垃圾回收过程中，确保所有被引用的 upvalues 被正确标记。
 * 它会遍历全局状态中的线程列表（通过 `g->twups` 访问），并根据线程的状态（灰色或黑色）以及是否存在打开的 upvalues 来决定是否保留线程在列表中。
 * 对于需要处理的线程，会遍历其所有打开的 upvalues，并标记那些被修改过的 upvalues 的值。
 *
 * @param g 全局状态指针，包含线程列表和垃圾回收相关信息。
 */
static void remarkupvals(global_State *g)
{
    lua_State *thread;
    lua_State **p = &g->twups;
    while ((thread = *p) != NULL) {
        lua_assert(!isblack(thread));  /* threads are never black */
        if (isgray(thread) && thread->openupval != NULL)
            p = &thread->twups;  /* keep marked thread with upvalues in the list */
        else {  /* thread is not marked or without upvalues */
            UpVal *uv;
            *p = thread->twups;  /* remove thread from the list */
            thread->twups = thread;  /* mark that it is out of list */
            for (uv = thread->openupval; uv != NULL; uv = uv->u.open.next) {
                if (uv->u.open.touched) {
                    markvalue(g, uv->v);  /* remark upvalue's value */
                    uv->u.open.touched = 0;
                }
            }
        }
    }
}

/*
** mark root set and reset all gray lists, to start a new collection
*/
/**
 * 重新启动垃圾回收器的标记阶段。
 * 该函数用于重置垃圾回收器的内部状态，并标记一些关键对象（如主线程、注册表等），
 * 以便在下一个垃圾回收周期中正确处理它们。
 *
 * @param g 全局状态指针，包含垃圾回收器的所有状态信息。
 */
static void restartcollection(global_State *g)
{
    // 清空所有灰色链表，将它们重置为 NULL
    g->gray = g->grayagain = NULL;
    g->weak = g->allweak = g->ephemeron = NULL;
    // 将垃圾回收状态设置为 GCSpropagate，表示进入标记阶段
    // 开始标记根对象（g->mainthread, g->l_registry）
    // 标记主线程
    markobject(g, g->mainthread);
    // 标记全局注册表
    markvalue(g, &g->l_registry);
    // 标记原表
    markmt(g);
    // 标记待终结对象
    markbeingfnz(g);  /* mark any finalizing object left from previous cycle */
}

/* }====================================================== */


/*
** {======================================================
** Traverse functions
** =======================================================
*/

/*
** Traverse a table with weak values and link it to proper list. During
** propagate phase, keep it in 'grayagain' list, to be revisited in the
** atomic phase. In the atomic phase, if table has any white value,
** put it in 'weak' list, to be cleared.
*/
/**
 * 遍历弱值表（weak value table），处理其中的空项和标记需要清理的项。
 *
 * 该函数用于垃圾回收阶段，主要完成以下任务：
 * 1. 遍历哈希部分，检查并移除空项（nil值）。
 * 2. 标记键（key）为活跃状态。
 * 3. 检测是否存在需要清理的弱值（white value），并标记表为需要清理。
 * 4. 根据当前垃圾回收状态，将表链接到相应的链表（grayagain 或 weak）中，以便后续处理。
 *
 * @param g 全局状态（global_State），包含垃圾回收相关的上下文信息。
 * @param h 待遍历的弱值表（Table）。
 */
static void traverseweakvalue(global_State *g, Table *h)
{
    Node *n, *limit = gnodelast(h);
    /* if there is array part, assume it may have white values (it is not
       worth traversing it now just to check) */
    int hasclears = (h->sizearray > 0);
    for (n = gnode(h, 0); n < limit; n++) {  /* traverse hash part */
        checkdeadkey(n);
        if (ttisnil(gval(n)))  /* entry is empty? */
            removeentry(n);  /* remove it */
        else {
            lua_assert(!ttisnil(gkey(n)));
            markvalue(g, gkey(n));  /* mark key */
            if (!hasclears && iscleared(g, gval(n)))  /* is there a white value? */
                hasclears = 1;  /* table will have to be cleared */
        }
    }
    if (g->gcstate == GCSpropagate)
        linkgclist(h, g->grayagain);  /* must retraverse it in atomic phase */
    else if (hasclears)
        linkgclist(h, g->weak);  /* has to be cleared later */
}

/*
** Traverse an ephemeron table and link it to proper list. Returns true
** iff any object was marked during this traversal (which implies that
** convergence has to continue). During propagation phase, keep table
** in 'grayagain' list, to be visited again in the atomic phase. In
** the atomic phase, if table has any white->white entry, it has to
** be revisited during ephemeron convergence (as that key may turn
** black). Otherwise, if it has any white key, table has to be cleared
** (in the atomic phase).
*/
/**
 * 遍历临时表（ephemeron table）并标记其中的对象。
 * 该函数用于垃圾回收过程中，处理临时表中的键值对，确保未被引用的对象被正确回收。
 *
 * @param g 全局状态指针，包含垃圾回收相关的上下文信息。
 * @param h 需要遍历的临时表。
 * @return 返回一个整数值：
 *   - 1：表示在遍历过程中有对象被标记。
 *   - 0：表示没有对象被标记。
 *
 * 函数逻辑：
 * 1. 遍历表的数组部分，标记所有未被标记的白色对象。
 * 2. 遍历表的哈希部分：
 *    - 移除空条目。
 *    - 检查键是否未被标记（cleared），并记录相关信息。
 *    - 标记未被标记的白色值对象。
 * 3. 根据表的状态（是否有白色键或白色键值对），将表链接到相应的垃圾回收列表中：
 *    - 如果处于传播阶段（GCSpropagate），链接到 `grayagain` 列表。
 *    - 如果有白色键值对，链接到 `ephemeron` 列表。
 *    - 如果有白色键，链接到 `allweak` 列表。
 */
static int traverseephemeron(global_State *g, Table *h)
{
    int marked = 0;    /* true if an object is marked in this traversal */
    int hasclears = 0; /* true if table has white keys */
    int hasww = 0;  /* true if table has entry "white-key -> white-value" */
    Node *n, *limit = gnodelast(h);
    unsigned int i;
    /* traverse array part */
    for (i = 0; i < h->sizearray; i++) {
        if (valiswhite(&h->array[i])) {
            marked = 1;
            reallymarkobject(g, gcvalue(&h->array[i]));
        }
    }
    /* traverse hash part */
    for (n = gnode(h, 0); n < limit; n++) {
        checkdeadkey(n);
        if (ttisnil(gval(n)))  /* entry is empty? */
            removeentry(n);  /* remove it */
        else if (iscleared(g, gkey(n))) {  /* key is not marked (yet)? */
            hasclears = 1;  /* table must be cleared */
            if (valiswhite(gval(n)))  /* value not marked yet? */
                hasww = 1;  /* white-white entry */
        } else if (valiswhite(gval(n))) {  /* value not marked yet? */
            marked = 1;
            reallymarkobject(g, gcvalue(gval(n)));  /* mark it now */
        }
    }
    // 如果在传播阶段，则将这个表链接到 grayagain 列表中，以便在原子阶段再次访问。
    /* link table into proper list */
    if (g->gcstate == GCSpropagate)
        linkgclist(h, g->grayagain);  /* must retraverse it in atomic phase */
    else if (hasww) {  /* table has white->white entries? */
        linkgclist(h, g->ephemeron);  /* have to propagate again */
    } else if (hasclears)  /* table has white keys? */
        linkgclist(h, g->allweak);  /* may have to clean white keys */
    return marked;
}

/**
 * 遍历强引用表（Table），标记其中的所有可达值，并清理无效的键值对。
 *
 * @param g 全局状态（global_State），用于垃圾回收的上下文。
 * @param h 待遍历的表（Table）。
 *
 * 功能说明：
 * 1. 遍历表的数组部分（array part），标记所有数组元素。
 * 2. 遍历表的哈希部分（hash part）：
 *    - 检查每个键值对是否为无效（nil），若无效则移除。
 *    - 标记有效的键和值，确保它们不会被垃圾回收。
 *
 * 注意：
 * - 此函数为静态函数，仅在当前模块内部使用。
 * - 主要用于垃圾回收过程中的标记阶段。
 */
static void traversestrongtable(global_State *g, Table *h)
{
    // 声明变量：n 和 limit，用于遍历哈希部分
    Node *n, *limit = gnodelast(h); // 先拿到哈希部分的最后一个节点
    unsigned int i;
    // 遍历表的数组部分，标记每个元素
    for (i = 0; i < h->sizearray; i++) { /* traverse array part */
        markvalue(g, &h->array[i]); // 将数组元素标记为活跃（灰色或黑色）
    }
   
    // 遍历表的哈希部分，处理每个键值对
    for (n = gnode(h, 0); n < limit; n++) {  /* traverse hash part */
        checkdeadkey(n);
        if (ttisnil(gval(n)))  /* entry is empty? */
            removeentry(n);  /* remove it */
        else {
            lua_assert(!ttisnil(gkey(n)));
            markvalue(g, gkey(n));  /* mark key */
            markvalue(g, gval(n));  /* mark value */
        }
    }
}

/**
 * 遍历并标记表（Table）的内存使用情况，处理弱引用模式。
 *
 * 该函数用于垃圾回收过程中遍历表，根据表的弱引用模式（weak mode）决定如何处理表中的键和值。
 * 如果表有弱引用模式（通过元表的 `__mode` 字段指定），则根据模式中的 'k' 和 'v' 标记决定是否弱引用键或值。
 * 如果表没有弱引用模式，则按强引用表处理。
 *
 * @param g 全局状态（global_State），包含垃圾回收的相关信息。
 * @param h 需要遍历的表（Table）。
 * @return 返回表及其相关结构占用的总内存大小（字节数）。
 */
static lu_mem traversetable(global_State *g, Table *h)
{
    // 声明变量：weakkey/weakvalue 用于标识弱键或弱值模式
    const char *weakkey, *weakvalue;
    // 获取表的元方法 TM_MODE（用于检测弱表模式）
    const TValue *mode = gfasttm(g, h->metatable, TM_MODE);
    // 标记元表本身（避免元表被GC回收）
    markobjectN(g, h->metatable);

    // 检查是否存在有效的弱表模式（模式需为字符串且包含'k'或'v'）
    if (mode && ttisstring(mode) && 
        ((weakkey = strchr(svalue(mode), 'k')),  // 查找'k'（弱键）
         (weakvalue = strchr(svalue(mode), 'v')), // 查找'v'（弱值）
         (weakkey || weakvalue))) {               // 确认是弱表
        black2gray(h);  // 将表从黑色降级为灰色（延迟处理弱引用）

        // 根据弱表类型分发处理逻辑：
        if (!weakkey) {  
            traverseweakvalue(g, h);  // 仅值弱：遍历强键弱值表
        } else if (!weakvalue) {  
            traverseephemeron(g, h);  // 仅键弱：遍历弱键强值表（临时表）
        } else {  
            linkgclist(h, g->allweak);  // 键值均弱：直接加入全弱表链表（无需遍历）
        }
    } else {  
        traversestrongtable(g, h);  // 非弱表：完全遍历键值（强引用）
    }

    // 返回表占用的总内存（表结构 + 数组部分 + 哈希节点部分）
    return sizeof(Table) + sizeof(TValue) * h->sizearray +
           sizeof(Node) * cast(size_t, allocsizenode(h));
}

/*
** Traverse a prototype. (While a prototype is being build, its
** arrays can be larger than needed; the extra slots are filled with
** NULL, so the use of 'markobjectN')
*/
/**
 * @brief 遍历并标记 Proto 结构体中的各个部分，用于垃圾回收。
 *
 * 该函数会遍历 Proto 结构体中的以下部分：
 * - 缓存对象（如果存在且为白色对象，则允许被回收）。
 * - 源代码对象。
 * - 字面量值（k 数组）。
 * - 上值名称（upvalues 数组中的 name 字段）。
 * - 嵌套的 Proto 对象（p 数组）。
 * - 局部变量名称（locvars 数组中的 varname 字段）。
 *
 * @param g 全局状态指针，用于垃圾回收操作。
 * @param f 指向 Proto 结构体的指针，表示待遍历的 Lua 函数原型。
 * @return 返回 Proto 结构体及其相关部分的总大小（以字节为单位）。
 */
static int traverseproto(global_State *g, Proto *f)
{
    int i;
    if (f->cache && iswhite(f->cache))
        f->cache = NULL;  /* allow cache to be collected */
    markobjectN(g, f->source);
    for (i = 0; i < f->sizek; i++)  /* mark literals */
    markvalue(g, &f->k[i]);
    for (i = 0; i < f->sizeupvalues; i++)  /* mark upvalue names */
    markobjectN(g, f->upvalues[i].name);
    for (i = 0; i < f->sizep; i++)  /* mark nested protos */
    markobjectN(g, f->p[i]);
    for (i = 0; i < f->sizelocvars; i++)  /* mark local-variable names */
    markobjectN(g, f->locvars[i].varname);
    return sizeof(Proto) + sizeof(Instruction) * f->sizecode +
           sizeof(Proto *) * f->sizep +
           sizeof(TValue) * f->sizek +
           sizeof(int) * f->sizelineinfo +
           sizeof(LocVar) * f->sizelocvars +
           sizeof(Upvaldesc) * f->sizeupvalues;
}

/**
 * 遍历并标记C闭包（CClosure）中的上值（upvalues）。
 *
 * @param g 全局状态（global_State）的指针，用于垃圾回收。
 * @param cl 指向C闭包的指针，包含需要标记的上值。
 * @return 返回C闭包的大小（以内存单位计算）。
 *
 * @note 此函数是垃圾回收的一部分，用于标记C闭包中的上值，确保它们不会被错误回收。
 */
static lu_mem traverseCclosure(global_State *g, CClosure *cl)
{
    int i;
    for (i = 0; i < cl->nupvalues; i++) /* mark its upvalues */
        markvalue(g, &cl->upvalue[i]);
    return sizeCclosure(cl->nupvalues);
}

/*
** open upvalues point to values in a thread, so those values should
** be marked when the thread is traversed except in the atomic phase
** (because then the value cannot be changed by the thread and the
** thread may not be traversed again)
*/
/**
 * 遍历并标记一个Lua闭包（LClosure）及其相关对象。
 *
 * 该函数用于垃圾回收过程中，标记闭包的原型（prototype）和上值（upvalues）。
 * 对于开放的上值（open upvalues），如果当前不在原子标记阶段（GCSinsideatomic），
 * 则标记为已触摸（touched），否则直接标记其值。
 *
 * @param g 全局状态指针，用于垃圾回收。
 * @param cl 待遍历的Lua闭包（LClosure）。
 * @return 返回闭包占用的内存大小（以lu_mem为单位）。
 */
static lu_mem traverseLclosure(global_State *g, LClosure *cl)
{
    int i;
    markobjectN(g, cl->p);                 /* mark its prototype */
    for (i = 0; i < cl->nupvalues; i++) {  /* mark its upvalues */
        UpVal *uv = cl->upvals[i];
        if (uv != NULL) {
            if (upisopen(uv) && g->gcstate != GCSinsideatomic)
                uv->u.open.touched = 1;  /* can be marked in 'remarkupvals' */
            else markvalue(g, uv->v);
        }
    }
    return sizeLclosure(cl->nupvalues);
}

/**
 * 遍历并标记线程栈中的活动元素，同时处理栈的清理和调整。
 *
 * @param g 全局状态指针，用于访问垃圾回收相关的状态和配置。
 * @param th 当前需要遍历的线程（lua_State）。
 * @return 返回线程占用的总内存大小，包括线程结构体、栈空间和调用信息。
 *
 * 功能说明：
 * 1. 遍历线程栈中的活动元素，并调用 `markvalue` 进行标记。
 * 2. 如果当前处于原子垃圾回收阶段（GCSinsideatomic），清理未标记的栈空间，
 *    并处理线程的 `twups` 列表（用于跟踪线程的开放上值）。
 * 3. 在非紧急垃圾回收模式下，调用 `luaD_shrinkstack` 调整栈大小。
 *
 * 注意事项：
 * - 如果栈尚未完全构建（`stack` 为 NULL），直接返回 1。
 * - 断言确保线程在特定状态下满足条件（如 `openupval` 为 NULL 或线程在 `twups` 列表中）。
 */
static lu_mem traversethread(global_State *g, lua_State *th)
{
    StkId o = th->stack;
    if (o == NULL)
        return 1;  /* stack not completely built yet */
    lua_assert(g->gcstate == GCSinsideatomic ||
               th->openupval == NULL || isintwups(th));
    for (; o < th->top; o++)  /* mark live elements in the stack */
    markvalue(g, o);
    if (g->gcstate == GCSinsideatomic) {  /* final traversal? */
        StkId lim = th->stack + th->stacksize;  /* real end of stack */
        for (; o < lim; o++)  /* clear not-marked stack slice */
            setnilvalue(o);
        /* 'remarkupvals' may have removed thread from 'twups' list */
        if (!isintwups(th) && th->openupval != NULL) {
            th->twups = g->twups;  /* link it back to the list */
            g->twups = th;
        }
    } else if (g->gckind != KGC_EMERGENCY)
        luaD_shrinkstack(th); /* do not change stack in emergency cycle */
    return (sizeof(lua_State) + sizeof(TValue) * th->stacksize +
            sizeof(CallInfo) * th->nci);
}

/*
** traverse one gray object, turning it to black (except for threads,
** which are always gray).
*/
/**
 * @brief 传播标记（propagate mark）函数，用于垃圾回收过程中的标记传播阶段。
 *
 * 该函数处理全局状态中的灰色对象（gray object），根据对象的类型调用相应的遍历函数，
 * 完成对象的标记传播，并更新垃圾回收的内存遍历统计。
 *
 * @param g 全局状态指针，包含垃圾回收的相关信息。
 *
 * 函数逻辑：
 * 1. 从全局状态的灰色列表中取出当前对象。
 * 2. 根据对象类型（表、闭包、线程、原型等）调用对应的遍历函数。
 * 3. 更新全局状态中的内存遍历统计。
 *
 * 注意：
 * - 该函数是静态函数，仅在当前模块内部使用。
 * - 调用前需确保对象为灰色（isgray(o)）。
 * - 调用后会根据对象类型将其从灰色列表中移除。
 */
static void propagatemark(global_State *g)
{
    /**
     * 关键机制解析：
        1. 三色标记与状态转换​​
        • 灰色对象表示​​自身已标记但引用未扫描​​，黑色表示​​自身及引用均已标记​​。gray2black是状态推进的核心操作。
        • 线程 (LUA_TTHREAD) 特殊处理：因其执行状态动态变化，需放回 grayagain链表并在原子阶段重新扫描，避免漏标。

        2. ​​增量回收与分步处理​​
        • 函数每次仅处理​​一个灰色对象​​，通过更新 g->gray链表实现分步操作，避免全量扫描的长停顿。
        • 内存统计 GCmemtrav用于控制单步工作量，实现增量回收的进度平衡。

        3. 弱表处理​​
        • 表遍历 (traversetable()) 内含弱表逻辑：弱键表需检查键值存活性，弱值表仅处理键。双白（键值均白）对象会暂存至 ephemeron链表，延迟至原子阶段处理。

        4. 写屏障与一致性​​
        • 若黑色对象在标记阶段​​新增引用白色对象​​，会触发写屏障（如 luaC_barrierback_），将黑色退灰保证不变式
     */
    lu_mem size;                 // 记录当前对象遍历过程中涉及的内存大小
    // 取出灰色链表中的第一个对象
    GCObject *o = g->gray;       // 从灰色链表中获取首个待处理对象（灰色对象需进一步扫描其引用）
    lua_assert(isgray(o));       // 断言验证对象确为灰色（确保状态正确）
    // 标记对象为黑色
    gray2black(o);               // 将对象标记为黑色（表示其自身已被标记，引用的对象待处理）

    // 这里为什么只有这种几种对象类型？因为数字、布尔、nil 都直接保存到变量中，不需要额外的内存分配（因为变量保存到栈中）
    // 为啥没有字符串？因为字符串不会引用其他对象，不需要对它进行传播标记。
    switch (o->tt) {             // 根据对象类型执行差异化处理
        case LUA_TTABLE: {       // 处理表类型
            Table *h = gco2t(o); // 转换为具体的表结构
            // 将表的gclist开始下一次遍历（更新链表头指针）
            g->gray = h->gclist; // 将表从灰色链表移除（更新链表头指针为表的gclist，这样，下次传播时，将从它的gclist开始继续传播）
            size = traversetable(g, h); // 遍历表的数组/哈希部分，处理弱表逻辑（弱键/弱值）
            break;
        }
        case LUA_TLCL: {         // 处理Lua闭包
            LClosure *cl = gco2lcl(o);
            g->gray = cl->gclist; 
            size = traverseLclosure(g, cl); // 遍历闭包的Upvalue和原型引用
            break;
        }
        case LUA_TCCL: {         // 处理C闭包
            CClosure *cl = gco2ccl(o);
            g->gray = cl->gclist;
            size = traverseCclosure(g, cl); // 处理C闭包的环境和Upvalue
            break;
        }
        case LUA_TTHREAD: {      // 处理协程线程
            lua_State *th = gco2th(o);
            g->gray = th->gclist; 
            linkgclist(th, g->grayagain); // 移入grayagain链表（需原子阶段再处理）[1,6](@ref)
            black2gray(o);        // 线程保持灰色（避免因异步修改导致漏标）
            size = traversethread(g, th); // 遍历线程栈和调用链
            break;
        }
        case LUA_TPROTO: {       // 处理函数原型
            Proto *p = gco2p(o);
            g->gray = p->gclist;
            size = traverseproto(g, p); // 遍历原型中的常量、局部变量等
            break;
        }
        default:                // 未定义类型触发断言
            lua_assert(0);
            return;
    }
    g->GCmemtrav += size;        // 累加本次遍历的内存到全局统计量
}

/**
 * 遍历并标记所有灰色对象，直到灰色对象列表为空。
 * 该函数用于垃圾回收过程中，确保所有可达对象都被正确标记。
 *
 * @param g 全局状态指针，包含当前灰色对象列表。
 */
static void propagateall(global_State *g)
{
    while (g->gray)
        propagatemark(g);
}

/**
 * 遍历并处理全局状态中的 ephemeron 表。
 *
 * 该函数用于处理 Lua 垃圾回收过程中的 ephemeron 表（弱键表）。
 * 它会遍历全局状态中的 ephemeron 表列表，并对每个表调用 `traverseephemeron` 函数。
 * 如果 `traverseephemeron` 标记了某些值，则会调用 `propagateall` 传播这些变化，
 * 并设置 `changed` 标志以重新遍历所有 ephemeron 表，直到没有变化为止。
 *
 * @param g 全局状态指针，包含垃圾回收相关的上下文信息。
 */
static void convergeephemerons(global_State *g)
{
    int changed;
    do
    {
        GCObject *w;
        GCObject *next = g->ephemeron;  /* get ephemeron list */
        g->ephemeron = NULL;  /* tables may return to this list when traversed */
        changed = 0;
        while ((w = next) != NULL) {
            next = gco2t(w)->gclist;
            if (traverseephemeron(g, gco2t(w))) {  /* traverse marked some value? */
                propagateall(g);  /* propagate changes */
                changed = 1;  /* will have to revisit all ephemeron tables */
            }
        }
    } while (changed);
}

/* }====================================================== */


/*
** {======================================================
** Sweep Functions
** =======================================================
*/

/*
** clear entries with unmarked keys from all weaktables in list 'l' up
** to element 'f'
*/
/**
 * 清理全局状态中的键值对。
 *
 * 该函数遍历给定的链表中的表（从 `l` 到 `f`），并检查每个表中的键值对：
 * - 如果键已被标记为清除（通过 `iscleared` 检查），则将其对应的值设为 `nil`。
 * - 如果键值对的值已经是 `nil`，则从表中移除该键值对。
 *
 * @param g 全局状态指针。
 * @param l 链表的起始节点（表）。
 * @param f 链表的结束节点（表）。
 */
static void clearkeys(global_State *g, GCObject *l, GCObject *f)
{
    for (; l != f; l = gco2t(l)->gclist)
    {
        Table *h = gco2t(l);
        Node *n, *limit = gnodelast(h);
        for (n = gnode(h, 0); n < limit; n++) {
            if (!ttisnil(gval(n)) && (iscleared(g, gkey(n)))) {
                setnilvalue(gval(n));  /* remove value ... */
            }
            if (ttisnil(gval(n)))  /* is entry empty? */
                removeentry(n);  /* remove entry from table */
        }
    }
}

/*
** clear entries with unmarked values from all weaktables in list 'l' up
** to element 'f'
*/
/**
 * 清除全局状态中指定范围内的表值。
 *
 * 该函数用于遍历从 `l` 到 `f` 的表链表，清除其中已被垃圾回收的值。
 * 对于每个表，它会检查数组部分和哈希部分的值，如果发现已被清除的值（通过 `iscleared` 判断），
 * 则将其设置为 `nil` 并从表中移除对应的条目。
 *
 * @param g 全局状态指针。
 * @param l 起始表对象。
 * @param f 结束表对象。
 */
static void clearvalues(global_State *g, GCObject *l, GCObject *f)
{
    for (; l != f; l = gco2t(l)->gclist)
    {
        Table *h = gco2t(l);
        Node *n, *limit = gnodelast(h);
        unsigned int i;
        for (i = 0; i < h->sizearray; i++) {
            TValue *o = &h->array[i];
            if (iscleared(g, o))  /* value was collected? */
                setnilvalue(o);  /* remove value */
        }
        for (n = gnode(h, 0); n < limit; n++) {
            if (!ttisnil(gval(n)) && iscleared(g, gval(n))) {
                setnilvalue(gval(n));  /* remove value ... */
                removeentry(n);  /* and remove entry from table */
            }
        }
    }
}

/**
 * 减少 UpVal 的引用计数，并在引用计数为零且 UpVal 未打开时释放其内存。
 *
 * @param L Lua 状态机指针。
 * @param uv 需要减少引用计数的 UpVal 指针。
 * @note 断言确保引用计数大于零。
 * @note 如果引用计数为零且 UpVal 未打开，则调用 luaM_free 释放内存。
 */
void luaC_upvdeccount(lua_State *L, UpVal *uv)
{
    lua_assert(uv->refcount > 0);
    uv->refcount--;
    if (uv->refcount == 0 && !upisopen(uv))
        luaM_free(L, uv);
}

/**
 * 释放一个Lua闭包（LClosure）及其关联的上值（upvalues）。
 *
 * @param L Lua状态机指针。
 * @param cl 待释放的Lua闭包指针。
 *
 * 函数会遍历闭包的所有上值，并减少它们的引用计数（通过`luaC_upvdeccount`）。
 * 最后，释放闭包占用的内存（通过`luaM_freemem`）。
 *
 * 注意：此函数为静态函数，仅在当前文件内部使用。
 */
static void freeLclosure(lua_State *L, LClosure *cl)
{
    int i;
    for (i = 0; i < cl->nupvalues; i++)
    {
        UpVal *uv = cl->upvals[i];
        if (uv)
            luaC_upvdeccount(L, uv);
    }
    luaM_freemem(L, cl, sizeLclosure(cl->nupvalues));
}

/**
 * 释放 Lua 垃圾回收对象 (GCObject) 的内存。
 *
 * 根据对象的类型 (o->tt) 调用相应的释放函数：
 * - LUA_TPROTO: 释放 Proto 对象
 * - LUA_TLCL: 释放 Lua 闭包对象
 * - LUA_TCCL: 释放 C 闭包对象
 * - LUA_TTABLE: 释放表对象
 * - LUA_TTHREAD: 释放线程对象
 * - LUA_TUSERDATA: 释放用户数据对象
 * - LUA_TSHRSTR: 从哈希表中移除短字符串并释放内存
 * - LUA_TLNGSTR: 释放长字符串内存
 *
 * 如果对象类型未知，触发断言错误。
 *
 * @param L Lua 状态机
 * @param o 待释放的垃圾回收对象
 */
static void freeobj(lua_State *L, GCObject *o)
{
    switch (o->tt)
    {
    case LUA_TPROTO:
        luaF_freeproto(L, gco2p(o));
        break;
    case LUA_TLCL:
    {
        freeLclosure(L, gco2lcl(o));
        break;
    }
    case LUA_TCCL:
    {
        luaM_freemem(L, o, sizeCclosure(gco2ccl(o)->nupvalues));
        break;
    }
    case LUA_TTABLE:
        luaH_free(L, gco2t(o));
        break;
    case LUA_TTHREAD:
        luaE_freethread(L, gco2th(o));
        break;
    case LUA_TUSERDATA:
        luaM_freemem(L, o, sizeudata(gco2u(o)));
        break;
    case LUA_TSHRSTR:
        luaS_remove(L, gco2ts(o)); /* remove it from hash table */
        luaM_freemem(L, o, sizelstring(gco2ts(o)->shrlen));
        break;
    case LUA_TLNGSTR:
    {
        luaM_freemem(L, o, sizelstring(gco2ts(o)->u.lnglen));
        break;
    }
    default:
        lua_assert(0);
    }
}

#define sweepwholelist(L, p)  sweeplist(L,p,MAX_LUMEM)

static GCObject **sweeplist(lua_State *L, GCObject **p, lu_mem count);

/*
** sweep at most 'count' elements from a list of GCObjects erasing dead
** objects, where a dead object is one marked with the old (non current)
** white; change all non-dead objects back to white, preparing for next
** collection cycle. Return where to continue the traversal or NULL if
** list is finished.
*/
/**
 * 遍历并清理垃圾回收链表中的对象。
 *
 * @param L Lua状态机指针。
 * @param p 指向垃圾回收链表中某个节点的指针的指针。
 * @param count 需要清理的对象数量上限。
 * @return 如果链表遍历完成（即到达链表末尾），返回NULL；否则返回指向下一个待处理节点的指针。
 *
 * 函数逻辑：
 * 1. 遍历链表中的对象，检查是否为“死亡”对象（即未被标记为存活的对象）。
 * 2. 如果是死亡对象，则从链表中移除并释放其内存。
 * 3. 如果是存活对象，则更新其标记为当前白色标记。
 * 4. 继续处理下一个对象，直到达到指定的数量上限或链表末尾。
 */
static GCObject **sweeplist(lua_State *L, GCObject **p, lu_mem count)
{
    global_State *g = G(L);
    int ow = otherwhite(g);
    int white = luaC_white(g);  /* current white */
    while (*p != NULL && count-- > 0) {
        GCObject *curr = *p;
        int marked = curr->marked;
        // 判断当前对象*p是否是“死亡”对象，如果是，则从链表中移除并释放其内存。
        if (isdeadm(ow, marked)) {  /* is 'curr' dead? */
            // 获取当前对象的下一个节点的指针，并回收当前对象
            *p = curr->next;  /* remove 'curr' from list */
            freeobj(L, curr);  /* erase 'curr' */
        } else {  /* change mark to 'white' */
            curr->marked = cast_byte((marked & maskcolors) | white);
            p = &curr->next;  /* go to next element */
        }
    }
    return (*p == NULL) ? NULL : p;
}

/*
** sweep a list until a live object (or end of list)
*/
/**
 * 遍历并清理垃圾回收链表，直到链表不再变化。
 *
 * @param L Lua状态机指针。
 * @param p 指向垃圾回收链表中某个节点的指针的指针。
 * @return 返回清理后的链表指针的指针。
 *
 * @note 该函数通过循环调用 `sweeplist` 来清理链表，直到链表不再发生变化。
 *       主要用于确保垃圾回收链表中的节点被完全清理。
 */
static GCObject **sweeptolive(lua_State *L, GCObject **p)
{
    GCObject **old = p;
    do
    {
        p = sweeplist(L, p, 1);
    } while (p == old);
    return p;
}

/* }====================================================== */


/*
** {======================================================
** Finalization
** =======================================================
*/

/*
** If possible, shrink string table
*/
/**
 * 检查并调整全局状态中的内存大小。
 * 如果当前垃圾回收模式不是紧急模式（KGC_EMERGENCY），则执行以下操作：
 * 1. 检查字符串表的使用情况，如果使用量小于表大小的四分之一，则缩小字符串表的大小。
 * 2. 更新垃圾回收的估计值（GCestimate）。
 *
 * @param L Lua 状态机指针。
 * @param g 全局状态指针。
 */
static void checkSizes(lua_State *L, global_State *g)
{
    if (g->gckind != KGC_EMERGENCY)
    {
        l_mem olddebt = g->GCdebt;
        if (g->strt.nuse < g->strt.size / 4)  /* string table too big? */
            luaS_resize(L, g->strt.size / 2);  /* shrink it a little */
        g->GCestimate += g->GCdebt - olddebt;  /* update estimate */
    }
}

/**
 * 从待终结列表（tobefnz）中取出第一个对象，并将其重新放回普通GC列表（allgc）。
 * 如果当前处于清扫阶段，还会将对象标记为白色（可回收状态）。
 *
 * @param g 全局状态指针。
 * @return 返回从待终结列表中取出的对象。
 *
 * @note 此函数用于处理需要终结的对象，将其从待终结列表中移除并恢复为普通对象。
 *       调用者需确保传入的对象确实在待终结列表中（通过断言验证）。
 */
static GCObject *udata2finalize(global_State *g)
{
    GCObject *o = g->tobefnz; /* get first element */
    lua_assert(tofinalize(o));
    g->tobefnz = o->next;  /* remove it from 'tobefnz' list */
    o->next = g->allgc;  /* return it to 'allgc' list */
    g->allgc = o;
    resetbit(o->marked, FINALIZEDBIT);  /* object is "normal" again */
    if (issweepphase(g))
        makewhite(g, o);  /* "sweep" object */
    return o;
}

/**
 * 执行一个无参数的 Lua 函数调用，不产生 yield。
 *
 * @param L Lua 状态机指针。
 * @param ud 未使用的参数（保留用于兼容性）。
 *
 * @note 此函数是内部实现细节，通常不直接暴露给外部调用。
 *       它通过 `luaD_callnoyield` 直接调用栈顶的函数，不检查参数数量。
 */
static void dothecall(lua_State *L, void *ud)
{
    UNUSED(ud);
    luaD_callnoyield(L, L->top - 2, 0);
}

/**
 * 执行垃圾回收元方法（__gc）的调用。
 *
 * 该函数用于在垃圾回收过程中调用用户定义的元方法（__gc），以执行对象的最终化操作。
 * 如果元方法执行过程中发生错误，会根据 `propagateerrors` 参数决定是否传播错误。
 *
 * @param L Lua 状态机指针。
 * @param propagateerrors 是否传播错误（非零表示传播错误）。
 *
 * 函数逻辑：
 * 1. 检查是否存在有效的 __gc 元方法。
 * 2. 在调用元方法期间禁用调试钩子和垃圾回收步骤。
 * 3. 调用元方法并处理可能的错误。
 * 4. 恢复调试钩子和垃圾回收状态。
 *
 * 注意：
 * - 如果元方法执行失败且 `propagateerrors` 为真，会抛出错误。
 * - 错误信息会被格式化并推送到 Lua 栈顶。
 */
static void GCTM(lua_State *L, int propagateerrors)
{
    global_State *g = G(L);
    const TValue *tm;
    TValue v;
    setgcovalue(L, &v, udata2finalize(g));
    tm = luaT_gettmbyobj(L, &v, TM_GC);
    if (tm != NULL && ttisfunction(tm)) {  /* is there a finalizer? */
        int status;
        lu_byte oldah = L->allowhook;
        int running = g->gcrunning;
        L->allowhook = 0;  /* stop debug hooks during GC metamethod */
        g->gcrunning = 0;  /* avoid GC steps */
        setobj2s(L, L->top, tm);  /* push finalizer... */
        setobj2s(L, L->top + 1, &v);  /* ... and its argument */
        L->top += 2;  /* and (next line) call the finalizer */
        L->ci->callstatus |= CIST_FIN;  /* will run a finalizer */
        status = luaD_pcall(L, dothecall, NULL, savestack(L, L->top - 2), 0);
        L->ci->callstatus &= ~CIST_FIN;  /* not running a finalizer anymore */
        L->allowhook = oldah;  /* restore hooks */
        g->gcrunning = running;  /* restore state */
        if (status != LUA_OK && propagateerrors) {  /* error while running __gc? */
            if (status == LUA_ERRRUN) {  /* is there an error object? */
                const char *msg = (ttisstring(L->top - 1))
                                  ? svalue(L->top - 1)
                                  : "no message";
                luaO_pushfstring(L, "error in __gc metamethod (%s)", msg);
                status = LUA_ERRGCMM;  /* error in __gc metamethod */
            }
            luaD_throw(L, status);  /* re-throw error */
        }
    }
}

/*
** call a few (up to 'g->gcfinnum') finalizers
*/
/**
 * 运行少量终结器（finalizers）。
 *
 * 该函数用于在垃圾回收过程中调用少量的终结器（finalizers）。
 * 它会遍历全局状态中的待终结对象列表（tobefnz），并调用指定数量的终结器。
 * 每次调用后，会根据剩余待终结对象的数量调整下次调用的终结器数量。
 *
 * @param L Lua 状态机指针。
 * @return 实际调用的终结器数量。
 *
 * @note 该函数是 Lua 垃圾回收器的内部实现细节，通常不直接暴露给用户。
 * @note 断言确保在调用终结器时，全局状态中的待终结对象列表和终结器数量一致。
 */
static int runafewfinalizers(lua_State *L)
{
    global_State *g = G(L);
    unsigned int i;
    lua_assert(!g->tobefnz || g->gcfinnum > 0);
    for (i = 0; g->tobefnz && i < g->gcfinnum; i++)
        GCTM(L, 1);  /* call one finalizer */
    g->gcfinnum = (!g->tobefnz) ? 0  /* nothing more to finalize? */
                                : g->gcfinnum * 2;  /* else call a few more next time */
    return i;
}

/*
** call all pending finalizers
*/
/**
 * 调用所有待处理的终结器（finalizers）。
 * 该函数遍历全局状态中的待处理终结器链表（tobefnz），
 * 并逐个调用 GCTM 函数处理这些终结器。
 *
 * @param L Lua 状态机指针。
 */
static void callallpendingfinalizers(lua_State *L)
{
    global_State *g = G(L);
    while (g->tobefnz)
        GCTM(L, 0);
}

/*
** find last 'next' field in list 'p' list (to add elements in its end)
*/
/**
 * 查找链表中的最后一个节点的指针。
 *
 * @param p 指向链表头节点指针的指针。
 * @return 返回指向最后一个节点指针的指针。
 */
static GCObject **findlast(GCObject **p)
{
    while (*p != NULL)
        p = &(*p)->next;
    return p;
}

/*
** move all unreachable objects (or 'all' objects) that need
** finalization from list 'finobj' to list 'tobefnz' (to be finalized)
*/
/**
 * 将需要执行终结操作的对象从 `finobj` 列表移动到 `tobefnz` 列表。
 *
 * @param g 全局状态指针，用于访问垃圾回收相关的数据结构。
 * @param all 布尔值，指示是否移动所有对象（无论是否正在被回收）。
 *            - 如果为真（非零），则移动所有对象。
 *            - 如果为假（零），则仅移动被标记为白色（正在回收）的对象。
 *
 * 函数遍历 `finobj` 列表中的每个对象：
 * 1. 如果对象未被标记为白色且 `all` 为假，则跳过该对象。
 * 2. 否则，将对象从 `finobj` 列表中移除，并链接到 `tobefnz` 列表的末尾。
 *
 * 注意：此函数是垃圾回收的内部实现细节，通常不直接暴露给外部调用。
 */
static void separatetobefnz(global_State *g, int all)
{
    GCObject *curr;
    GCObject **p = &g->finobj;
    GCObject **lastnext = findlast(&g->tobefnz);
    while ((curr = *p) != NULL) {  /* traverse all finalizable objects */
        lua_assert(tofinalize(curr));
        if (!(iswhite(curr) || all))  /* not being collected? */
            p = &curr->next;  /* don't bother with it */
        else {
            *p = curr->next;  /* remove 'curr' from 'finobj' list */
            curr->next = *lastnext;  /* link at the end of 'tobefnz' list */
            *lastnext = curr;
            lastnext = &curr->next;
        }
    }
}

/*
** if object 'o' has a finalizer, remove it from 'allgc' list (must
** search the list to find it) and link it in 'finobj' list.
*/
/**
 * 这个函数的作用是在创建对象的时候，判断对象是否提供了finalizer元方法，
 * 如果提供了，则将对象从allgc链表中移除，并添加到finobj链表中。目的是在gc时，放在一个单独的步骤中，因为终结器可能耗时。
 * 
 * 检查并处理对象的终结器（finalizer）。
 *
 * 如果对象已经标记为需要终结处理，或者对象的元表中没有定义终结器（TM_GC），则直接返回。
 * 否则，将对象从全局的 `allgc` 链表中移除，并移动到 `finobj` 链表中，同时标记为已终结。
 *
 * @param L Lua 状态机。
 * @param o 需要检查的 GCObject 对象。
 * @param mt 对象的元表。
 *
 * @note 在垃圾回收的扫描阶段（sweep phase），会确保对象不会被错误地移除。
 */
void luaC_checkfinalizer(lua_State *L, GCObject *o, Table *mt)
{
    global_State *g = G(L);
    // 判断对象是否已经标记了或者没有终结器，如果是则直接返回
    if (tofinalize(o) ||               /* obj. is already marked... */
        gfasttm(g, mt, TM_GC) == NULL) /* or has no finalizer? */
        return;  /* nothing to be done */
    else {  /* move 'o' to 'finobj' list */
        GCObject **p;
        if (issweepphase(g)) {
            makewhite(g, o);  /* "sweep" object 'o' */
            if (g->sweepgc == &o->next)  /* should not remove 'sweepgc' object */
                g->sweepgc = sweeptolive(L, g->sweepgc);  /* change 'sweepgc' */
        }
        /* search for pointer pointing to 'o' */
        for (p = &g->allgc; *p != o; p = &(*p)->next) { /* empty */ }
        *p = o->next;  /* remove 'o' from 'allgc' list */
        o->next = g->finobj;  /* link it in 'finobj' list */
        g->finobj = o;
        l_setbit(o->marked, FINALIZEDBIT);  /* mark it as such */
    }
}

/* }====================================================== */



/*
** {======================================================
** GC control
** =======================================================
*/

/*
** Set a reasonable "time" to wait before starting a new GC cycle; cycle
** will start when memory use hits threshold. (Division by 'estimate'
** should be OK: it cannot be zero (because Lua cannot even start with
** less than PAUSEADJ bytes).
*/
/**
 * 设置垃圾回收的暂停阈值。
 *
 * 根据全局状态 `g` 中的当前内存使用情况和配置参数 `gcpause`，计算并设置垃圾回收的暂停阈值。
 * 该函数通过调整 `estimate` 值来避免溢出，并确保阈值在合理范围内。
 *
 * @param g 全局状态指针，包含垃圾回收相关的配置和状态信息。
 */
/* 设置GC的暂停阈值（pause threshold）和内存债务（debt） */
static void setpause(global_State *g)
{
    l_mem threshold, debt; // threshold: 暂停阈值，debt: 内存债务
    /* 调整后的内存估计值：GCestimate是GC对存活内存的估计，PAUSEADJ是调整因子 */
    l_mem estimate = g->GCestimate / PAUSEADJ; 
    lua_assert(estimate > 0); // 确保估计值大于0，否则断言失败
    
    /* 计算阈值：g->gcpause是GC的暂停参数（百分比），控制GC的激进程度。
       检查 (g->gcpause * estimate) 是否会溢出。如果会，则使用最大值MAX_LMEM */
    threshold = (g->gcpause < MAX_LMEM / estimate)  /* 检查是否可能溢出? */
                ? estimate * g->gcpause  /* 无溢出，正常计算：阈值 = 估计值 * 暂停比例 */
                : MAX_LMEM;  /* 可能溢出，则使用最大内存值限制 */
    
    /* 计算当前内存债务：当前总内存占用减去阈值 */
    debt = gettotalbytes(g) - threshold;
    
    /* 设置GC的内存债务，这将影响GC下次触发的时机 */
    luaE_setdebt(g, debt);
}

/*
** Enter first sweep phase.
** The call to 'sweeplist' tries to make pointer point to an object
** inside the list (instead of to the header), so that the real sweep do
** not need to skip objects created between "now" and the start of the
** real sweep.
*/
/**
 * 进入垃圾回收的清扫阶段。
 * 该函数将全局状态机的垃圾回收状态设置为 GCSswpallgc，并初始化清扫列表。
 *
 * @param L Lua 状态机指针。
 */
static void entersweep(lua_State *L)
{
    global_State *g = G(L);
    g->gcstate = GCSswpallgc;
    lua_assert(g->sweepgc == NULL);
    // 从allgc开始遍历，将第一个对象作为清扫列表的起始点。
    g->sweepgc = sweeplist(L, &g->allgc, 1);
}

/**
 * 释放 Lua 状态中的所有对象。
 * 该函数会处理所有带有终结器的对象，并调用所有待处理的终结器。
 * 然后，将所有对象标记为“死亡”状态，并清理全局状态中的各个对象列表。
 *
 * @param L Lua 状态指针。
 *
 * 函数执行后，全局状态中的对象列表（如 `finobj`、`allgc`、`fixedgc`）将被清空，
 * 并且字符串表的使用计数会被重置为 0。
 */
void luaC_freeallobjects(lua_State *L)
{
    global_State *g = G(L);
    separatetobefnz(g, 1); /* separate all objects with finalizers */
    lua_assert(g->finobj == NULL);
    callallpendingfinalizers(L);
    lua_assert(g->tobefnz == NULL);
    g->currentwhite = WHITEBITS; /* this "white" makes all objects look dead */
    g->gckind = KGC_NORMAL;
    sweepwholelist(L, &g->finobj);
    sweepwholelist(L, &g->allgc);
    sweepwholelist(L, &g->fixedgc);  /* collect fixed objects */
    lua_assert(g->strt.nuse == 0);
}

/**
 * 执行原子性的垃圾回收阶段。
 *
 * 该函数是 Lua 垃圾回收器的一部分，负责在原子阶段完成以下任务：
 * 1. 标记所有活跃对象（包括运行中的线程、注册表、全局元表等）。
 * 2. 处理弱表（weak tables）和临时表（ephemeron tables）中的键值对。
 * 3. 分离需要执行终结器的对象。
 * 4. 清理缓存并翻转当前白色标记。
 *
 * @param L Lua 状态机指针。
 * @return 返回在此阶段标记的内存工作量的估计值。
 *
 * @note 该函数假设在调用时已经满足以下条件：
 * - `g->ephemeron` 和 `g->weak` 必须为 NULL。
 * - 主线程不能被标记为白色。
 */
static l_mem atomic(lua_State *L)
{
    // 获取全局状态指针
    global_State *g = G(L);
    // 记录内存工作量的变量
    l_mem work;
    // 保存原始的弱表链表指针，用于后续比较
    GCObject *origweak, *origall;
    // 保存grayagain链表（用于处理屏障后退的对象）的原始指针
    GCObject *grayagain = g->grayagain;  /* save original list */
    
    // 断言：检查ephemeron（键弱引用表）和弱表链表是否为空
    // 蜉蝣表（ephemeron）是键弱引用表，用于存储键值对，其中键和值都可以是弱引用。
    lua_assert(g->ephemeron == NULL && g->weak == NULL);
    // 断言：确保主线程不是白色（应已被标记）
    lua_assert(!iswhite(g->mainthread));
    
    // 将垃圾回收状态设置为“原子阶段内部”
    g->gcstate = GCSinsideatomic;
    // 重置内存遍历计数器，开始统计本阶段的工作量
    g->GCmemtrav = 0;  /* start counting work */
    
    // 标记当前正在运行的Lua线程（主线程）
    markobject(g, L);  /* mark running thread */
    
    // 标记注册表（可能被API更改）
    markvalue(g, &g->l_registry);
    // 标记全局元表（可能被API更改）
    markmt(g);  /* mark global metatables */
    
    // 重新标记（可能存在的）死线程的临时上值
    remarkupvals(g);
    // 完全传播所有标记变化（清空gray链表）
    propagateall(g);  /* propagate changes */
    
    // 记录当前工作量（GCmemtrav），但不包括即将处理的grayagain
    work = g->GCmemtrav;  /* stop counting (do not recount 'grayagain') */
    
    // 将gray链表指向之前保存的grayagain链表
    g->gray = grayagain;
    // 完全传播grayagain链表中的标记
    propagateall(g);  /* traverse 'grayagain' list */
    
    // 重启内存遍历计数器，用于后续阶段统计
    g->GCmemtrav = 0;  /* restart counting */
    
    // 集中处理所有ephemeron表（键弱引用表），直到收敛（无新标记）
    convergeephemerons(g);
    
    // 此时，所有强可达对象都已被标记
    /* at this point, all strongly accessible objects are marked. */
    
    // 在检查终结器前，先清空弱表中的值
    clearvalues(g, g->weak, NULL);
    clearvalues(g, g->allweak, NULL);
    
    // 保存当前弱表和全弱表链表的原始状态
    origweak = g->weak;
    origall = g->allweak;
    // 累加内存工作量（至此的对象标记）
    work += g->GCmemtrav;  /* stop counting (objects being finalized) */
    
    // 分离出需要执行终结器的对象
    separatetobefnz(g, 0);  /* separate objects to be finalized */
    // 设置标志，表示可能存在需要终结的对象
    g->gcfinnum = 1;  /* there may be objects to be finalized */
    
    // 标记那些即将被终结的对象（“复活”的对象）
    markbeingfnz(g);  /* mark objects that will be finalized */
    // 再次完全传播标记，以传播“复活”对象带来的变化
    propagateall(g);  /* remark, to propagate 'resurrection' */
    
    // 重启内存遍历计数器
    g->GCmemtrav = 0;  /* restart counting */
    // 再次处理ephemeron表，因为“复活”可能产生了新的变化
    convergeephemerons(g);
    
    // 此时，所有复活对象都已被标记
    /* at this point, all resurrected objects are marked. */
    
    // 从所有ephemeron表中移除死键
    clearkeys(g, g->ephemeron, NULL);  /* clear keys from all ephemeron tables */
    // 从所有'allweak'表中移除死键
    clearkeys(g, g->allweak, NULL);  /* clear keys from all 'allweak' tables */
    
    // 从“复活”的弱表中清除值（与原始状态比较）
    clearvalues(g, g->weak, origweak);
    clearvalues(g, g->allweak, origall);
    
    // 清理字符串缓存
    luaS_clearcache(g);
    // 切换当前白色（翻转白色位）以进行下一轮回收
    g->currentwhite = cast_byte(otherwhite(g));  /* flip current white */
    
    // 累加最终的内存工作量
    work += g->GCmemtrav;  /* complete counting */
    
    // 返回此原子阶段标记的内存总量估计值
    return work;  /* estimate of memory marked by 'atomic' */
}

/**
 * 执行一步垃圾回收的清扫操作。
 *
 * @param L Lua状态机指针。
 * @param g 全局状态指针。
 * @param nextstate 清扫完成后进入的下一个状态。
 * @param nextlist 清扫完成后需要处理的下一组对象列表。
 * @return 返回本次清扫操作的工作量（以GC成本单位计算），如果清扫完成则返回0。
 *
 * 功能说明：
 * - 如果当前有需要清扫的对象（g->sweepgc不为空），则调用sweeplist清扫最多GCSWEEPMAX个对象。
 * - 更新GCestimate以反映清扫后的内存变化。
 * - 如果仍有未清扫的对象，返回GCSWEEPMAX * GCSWEEPCOST表示需要继续清扫。
 * - 如果没有更多需要清扫的对象，则进入下一个状态（nextstate），并设置下一组需要清扫的对象列表（nextlist）。
 */
static lu_mem sweepstep(lua_State *L, global_State *g,
                        int nextstate, GCObject **nextlist)
{
    if (g->sweepgc)
    {
        l_mem olddebt = g->GCdebt;
        // 这里一次清理并不一定能完全把链表中的所有对象都清理完，有最大值限制，目的还是尽量减少 stop the world 的时间
        g->sweepgc = sweeplist(L, g->sweepgc, GCSWEEPMAX);
        g->GCestimate += g->GCdebt - olddebt;  /* update estimate */
        if (g->sweepgc)  /* is there still something to sweep? */
            return (GCSWEEPMAX * GCSWEEPCOST);
    }
    /* else enter next state */
    g->gcstate = nextstate;
    g->sweepgc = nextlist;
    return 0;
}

/**
 * @brief 执行垃圾回收的单步操作。
 *
 * 该函数根据当前垃圾回收的状态（gcstate）执行相应的单步操作，并返回该步骤中遍历的内存大小。
 * 它是垃圾回收过程的核心函数，负责处理不同阶段的逻辑。
 *
 * @param L Lua状态机指针。
 * @return lu_mem 返回当前步骤中遍历的内存大小（以字节为单位）。
 *
 * @note 函数内部通过全局状态（global_State）的gcstate字段判断当前阶段，并执行以下操作：
 * - GCSpause: 初始化垃圾回收，设置初始内存遍历大小并进入传播阶段。
 * - GCSpropagate: 传播标记，处理灰色对象，直到没有灰色对象时进入原子阶段。
 * - GCSatomic: 确保灰色列表为空，执行原子操作并进入清扫阶段。
 * - GCSswpallgc: 清扫常规对象。
 * - GCSswpfinobj: 清扫带有终结器的对象。
 * - GCSswptobefnz: 清扫待终结的对象。
 * - GCSswpend: 完成清扫，检查大小并进入终结器调用阶段。
 * - GCScallfin: 调用剩余的终结器，如果没有终结器或处于紧急模式，则结束回收。
 *
 * @warning 如果gcstate为未知值，函数会触发断言错误。
 */
static lu_mem singlestep(lua_State *L)
{
    // 获取全局状态（global_State），包含 GC 相关参数和状态
    global_State *g = G(L);
    // 根据当前 GC 状态执行对应阶段的回收操作
    switch (g->gcstate)
    {
    case GCSpause:  // 初始暂停状态：准备开始新 GC 周期
    {
        // 初始化内存遍历量：计算字符串表（strt）的大小（哈希桶数量 * 指针大小）
        g->GCmemtrav = g->strt.size * sizeof(GCObject *);
        // 从这里，开始准备开始新的 GC 周期。restartcollection方法中，会重置 GC 状态，清空灰色链表，重置内存遍历量。开始从根对象开始标记。
        restartcollection(g);   // 重置 GC 内部状态，初始化标记链表
        g->gcstate = GCSpropagate; // 切换到标记传播阶段
        return g->GCmemtrav;    // 返回本阶段遍历的内存工作量
    }
    case GCSpropagate:  // 标记传播阶段：遍历灰色对象图
    {
        g->GCmemtrav = 0;       // 重置本阶段内存遍历计数器
        lua_assert(g->gray);    // 断言灰色链表非空（应有待处理对象）
        // 从global_State的gray链表开始，遍历并标记所有可达对象
        propagatemark(g);       // 标记一个灰色对象及其引用，将其转为黑色
        // 若灰色链表为空，标记完成
        // 需要注意，这里只是将状态设置为原子标记状态，并不代表立刻进入原子标记阶段
        if (g->gray == NULL)        /* 无更多灰色对象？ */
            g->gcstate = GCSatomic; /* 进入原子标记阶段,  */
        return g->GCmemtrav;        /* 返回本步骤遍历的内存量 */
    }
    case GCSatomic:  // 原子标记阶段：处理并发场景的剩余标记
    {
        lu_mem work;
        // 在GSCpropagate阶段，将所有灰色对象标记为黑色后，灰色链表为空, 为什么还进行了一次清理？
        propagateall(g);  // 确保灰色链表完全清空（处理残余对象）
        work = atomic(L); // 执行原子操作，返回遍历的内存量
        entersweep(L);    // 进入清扫阶段, 从allgc链表开始清扫对象
        // 首次估算 GC 后内存总量（用于设置下周期阈值）
        g->GCestimate = gettotalbytes(g);
        return work;      // 返回原子阶段遍历的内存量
    }
    case GCSswpallgc:  // 清扫常规对象（无终结器的对象）
    { 
        // 清扫常规对象，并推进到下一状态（GCSswpfinobj）
        return sweepstep(L, g, GCSswpfinobj, &g->finobj);
    }
    case GCSswpfinobj:  // 清扫带终结器的对象（需特殊处理）
    { 
        // 清扫 finobj 链表，推进到下一状态（GCSswptobefnz）
        return sweepstep(L, g, GCSswptobefnz, &g->tobefnz);
    }
    case GCSswptobefnz:  // 清扫待终结对象（已调用析构但待回收）
    { 
        // 清扫 tobefnz 链表，推进到结束状态（GCSswpend）
        return sweepstep(L, g, GCSswpend, NULL);
    }
    case GCSswpend:  // 清扫结束阶段：收尾工作
    {                                
        makewhite(g, g->mainthread); // 主线程标记为白色（下次 GC 可回收）
        checkSizes(L, g);            // 检查内存使用并调整 GC 参数
        g->gcstate = GCScallfin;     // 切换到终结器调用阶段
        return 0;                    // 本步骤无内存遍历量
    }
    case GCScallfin:  // 终结器调用阶段：执行剩余析构器
    { 
        // 存在待处理的终结器且非紧急 GC 模式
        if (g->tobefnz && g->gckind != KGC_EMERGENCY)
        {
            int n = runafewfinalizers(L); // 运行少量终结器
            return (n * GCFINALIZECOST);  // 返回估算的工作量（避免过度占用 CPU）
        }
        else  // 紧急模式或无终结器
        {                          
            g->gcstate = GCSpause; // 回到初始状态，结束本轮 GC
            return 0;              // 无工作量
        }
    }
    default:  // 非法状态处理
        lua_assert(0); // 触发断言错误（不可达状态）
        return 0;
    }
}

/*
** advances the garbage collector until it reaches a state allowed
** by 'statemask'
*/
/**
 * 将垃圾回收器的状态推进到指定的状态掩码中的某个状态。
 * 该函数会持续调用单步垃圾回收（singlestep），直到当前垃圾回收器的状态匹配给定的状态掩码。
 *
 * @param L Lua 状态机指针。
 * @param statesmask 目标状态掩码，用于指定期望的垃圾回收器状态。
 */
void luaC_runtilstate(lua_State *L, int statesmask)
{
    global_State *g = G(L);
    while (!testbit(statesmask, g->gcstate))
        singlestep(L);
}

/*
** get GC debt and convert it from Kb to 'work units' (avoid zero debt
** and overflows)
*/
/**
 * 计算并返回当前GC（垃圾回收）的债务值。
 *
 * @param g 全局状态指针，包含GC相关的状态信息。
 * @return 计算后的GC债务值。如果当前债务值小于等于0，则返回0。
 *
 * @note 债务值的计算基于以下规则：
 * 1. 如果债务值小于等于0，直接返回0。
 * 2. 否则，将债务值除以STEPMULADJ并加1，然后乘以gcstepmul。
 * 3. 如果计算结果超过MAX_LMEM，则返回MAX_LMEM。
 */
static l_mem getdebt(global_State *g)
{
    l_mem debt = g->GCdebt;
    int stepmul = g->gcstepmul;
    if (debt <= 0) return 0;  /* minimal debt */
    else {
        debt = (debt / STEPMULADJ) + 1;
        debt = (debt < MAX_LMEM / stepmul) ? debt * stepmul : MAX_LMEM;
        return debt;
    }
}

/*
** performs a basic GC step when collector is running
*/
/**
 * @brief 执行单步垃圾回收操作。
 *
 * 该函数负责执行垃圾回收的单步操作，根据当前垃圾回收状态和债务（debt）决定是否继续执行回收步骤。
 * 如果垃圾回收未运行，则设置一个较大的债务以避免频繁调用。
 * 在循环中执行单步回收操作，直到债务足够小或垃圾回收进入暂停状态。
 * 如果垃圾回收进入暂停状态，则设置暂停；否则，调整债务并运行少量终结器。
 *
 * @param L Lua状态机指针。
 */
void luaC_step(lua_State *L)
{
    // 获取全局状态（global_State），包含GC相关参数
    global_State *g = G(L);
    // 计算当前GC需处理的债务（debt），基于GCdebt和gcstepmul调整
    l_mem debt = getdebt(g); /* GC deficit (be paid now) */

    // 若GC未运行（如手动暂停后）
    if (!g->gcrunning) {  /* not running? */
        // 设置负债务，避免频繁触发GC检查
        luaE_setdebt(g, -GCSTEPSIZE * 10);  /* avoid being called too often */
        return;
    }

    // 执行GC单步操作，直到债务低于阈值或进入暂停状态
    do {  /* repeat until pause or enough "credit" (negative debt) */
        // 执行一个GC步骤（如标记、清除等），返回处理的内存工作量
        lu_mem work = singlestep(L);  /* perform one single step */
        // 减少剩余债务
        debt -= work;
    } while (debt > -GCSTEPSIZE && g->gcstate != GCSpause);

    // 检查GC是否完成一个完整周期（到达暂停状态）
    if (g->gcstate == GCSpause)
        // 设置下一次GC触发阈值（基于gcpause参数）
        setpause(g);  /* pause until next cycle */
    else {
        // 未完成周期时，将剩余债务转换为内存单位（KB）
        // 公式：debt = (debt / gcstepmul) * STEPMULADJ
        debt = (debt / g->gcstepmul) * STEPMULADJ;  /* convert 'work units' to Kb */
        // 更新全局债务状态
        luaE_setdebt(g, debt);
        // 执行少量待处理的析构器（如userdata的__gc方法）
        runafewfinalizers(L);
    }
}

/*
** Performs a full GC cycle; if 'isemergency', set a flag to avoid
** some operations which could change the interpreter state in some
** unexpected ways (running finalizers and shrinking some structures).
** Before running the collection, check 'keepinvariant'; if it is true,
** there may be some objects marked as black, so the collector has
** to sweep all objects to turn them back to white (as white has not
** changed, nothing will be collected).
*/
/**
 * 执行一次完整的垃圾回收（GC）周期。
 *
 * @param L Lua状态机指针。
 * @param isemergency 是否为紧急模式。如果为真，GC将以紧急模式运行。
 *
 * 功能说明：
 * - 确保当前GC状态为正常模式（KGC_NORMAL）。
 * - 如果启用了紧急模式，将GC状态设置为紧急模式（KGC_EMERGENCY）。
 * - 如果当前存在黑色对象（表示需要保持不变量），则进入清扫阶段将其转为白色。
 * - 完成任何挂起的清扫阶段，并启动一个新的GC周期。
 * - 运行直到调用终结器（GCScallfin）阶段。
 * - 确保GC估计值与实际内存使用量一致。
 * - 完成GC周期后，恢复为正常模式，并设置暂停阈值。
 *
 * 注意：
 * - 该函数通常用于强制触发一次完整的GC，适用于内存压力较大的场景。
 * - 紧急模式可能影响GC的性能和效率，仅在必要时使用。
 */
void luaC_fullgc(lua_State *L, int isemergency)
{
    global_State *g = G(L);
    lua_assert(g->gckind == KGC_NORMAL);
    if (isemergency) g->gckind = KGC_EMERGENCY;  /* set flag */
    if (keepinvariant(g)) {  /* black objects? */
        entersweep(L); /* sweep everything to turn them back to white */
    }
    /* finish any pending sweep phase to start a new cycle */
    luaC_runtilstate(L, bitmask(GCSpause));
    luaC_runtilstate(L, ~bitmask(GCSpause));  /* start new collection */
    luaC_runtilstate(L, bitmask(GCScallfin));  /* run up to finalizers */
    /* estimate must be correct after a full GC cycle */
    lua_assert(g->GCestimate == gettotalbytes(g));
    luaC_runtilstate(L, bitmask(GCSpause));  /* finish collection */
    g->gckind = KGC_NORMAL;
    setpause(g);
}

/* }====================================================== */


